pp108 : sendMessage (JMS)

sendMessage (JMS)

This API sends a message to a destination.

SOAP request

Example plain text request 
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
 <SOAP:Body>
  <sendMessage xmlns="http://schemas.cordys.com/1.0/jms" >
    <destination>MyDestinationManager.MyDestination</destination>
    <message>Test message</message>
  </sendMessage>
  </SOAP:Body>
</SOAP:Envelope>
Example XML request 
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
 <SOAP:Body>
  <sendMessage xmlns="http://schemas.cordys.com/1.0/jms" >
    <destination>MyDestinationManager.MyDestination</destination>
    <message>
      <data>
        <text>This is my example request.</text>
      </data>
    </message>
  </sendMessage>
  </SOAP:Body>
</SOAP:Envelope>

Request parameters

Parameter Description Mandatory Accepted input values
destination Destination identifier to send a message Y For dynamic destinations, the physical-name attribute can be added to the element to send the message to that queue or topic. The value is provider-specific, for example, queue://manager.queue .
reply2destination Destination identifier to which the recipient must reply N For dynamic destinations, the physical-name   attribute can be added.
correlationid Correlation ID to be used N  
persistentdelivery Attribute on the API node N The default value is true.
expiration Attribute on the API node N

The default is no expiration.

Note: The message expiration is in milliseconds.
priority Attribute on the API node N Message priority value (-1  to 9).
jmstype JMS type to be used N

The possible values are:

  • Queue
  • Topic
properties Properties of the message N

Multiple properties can be sent. Properties have the following attributes to be sent:

  • name (Mandatory)
  • value
  • type
messageformat Contains base64 if the message node content is Base64 encoded, or the name of one of the configured BTC protocol names N If not set or empty, the message is sent as plain text.
message

Message to send

 Y If Binary Transformation is configured, this is expected as XML. Otherwise, you can have the following situations:
  • The message node contains plain text, and the message is sent as is.
  • The message node contains XML, and the XML is converted to a string and sent as plain text.

SOAP response

Example response 
<SendMessageResponse xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://schemas.cordys.com/jmsconnector/operations/3.0">
    <messageid>ID:F0BSD02-57872-1430208201916-1:1:2:1:1</messageid>
</SendMessageResponse>

Response parameters

Parameter Description
messageid ID of the sent message